Creating and editing briefcase option sets


	BlueCielo TeamWork 2012 Configuration Guide \| BlueCielo ECM Solutions

You are here: Understanding briefcases > Creating and editing briefcase option sets

Creating and editing briefcase option sets

A briefcase option set is a named combination of option settings that are used for a specific purpose. Option sets are combined with briefcase formats to form briefcase templates. Your organization might want all briefcases created the same, or it might want them created differently for different purposes. You should create an option set for each combination of different option settings.

To create or edit a briefcase option set:

In Configurator, expand Environment in the configuration tree and select Application Link Settings. The settings for each link appear in property pages in the right pane.
Click the Briefcases tab. The Briefcase settings page appears in the right pane.
Click the Edit button to modify the settings.

Tip To export the settings file to your computer, click the Export button. This can be useful if you would rather edit the file in your favorite text editor. You can then copy your changes to the Clipboard and paste them into Configurator.

In the [Settings] section, locate the BriefcaseSettings setting. This setting lists the different option set names included in the configuration. The Default setting in this section specifies the default option set to be used if the user does not select an option set.
To create a new option set, add a new name to the end of this list following a comma. To remove an option set, delete its name from this list.
Each option set includes General, Transmittals, and PropertyMappings sections that contain the settings listed in the following table. Each section is indicated by commented lines that begin with a semicolon. The General section specifies defaults for options that are presented to users when briefcases are created. The Transmittals section specifies options for system-generated transmittal reports that can be included in briefcases. The PropertyMappings section specifies document properties that are copied to the briefcase metadata.

To edit an option set:

Locate the line in the file that corresponds to the option set name that you want to edit. For example, to edit the options for the set named MySettings, locate the section that begins with [MySettings].

To create a new option set:

Copy an existing option set (including its section name in square brackets and all settings up to the next section name in square brackets) to an empty line at the end of the Settings definitions section and change the option set name to a name of your choice.

Using the comments in the property page, edit each option in the section as necessary. Unless otherwise noted, type Y or N to indicate that the option should be enabled or cleared, respectively. For example, to enable the CheckOut option, type CheckOut=Y.
Click OK to save your changes.

Briefcase option set settings
Option	Description
General section
Name	Name of the option set as seen by users.
CheckOut	If Y, when the Add to Briefcase dialog is shown to users, the Check out and include current revision option is selected by default. Otherwise, the Only include current revision option is selected by default.
CheckOutReferenced	If Y, when the Add to Briefcase dialog is shown to users, the Check out referenced documents option is selected by default.
IncludeCADPresentation	If Y, when the Add to Briefcase dialog is shown to users, the Include drawing and presentation files option is selected by default.
IncludeCADReferenced	If Y, when the Add to Briefcase dialog is shown to users, the Include CAD references option is selected by default.
IncludeCustomReferenced	If Y, when the Add to Briefcase dialog is shown to users, the Include custom references option is selected by default.
RedlineLayers	Comma-separated list of names of the redline layers to include in the briefcase.
SyncPropertiesOnImport	If Y, the Synchronize Properties from File command is executed on all documents after they are imported from the briefcase.
UseRelativePathsOnImport	If Y, and the briefcase contains a Path property, then imported documents are placed in a subfolder of the selected folder. The subfolder is named with the value of the property. Note This option must be N to show the New Document Wizard when documents are imported from the briefcase.
UseReleasedVersion	If Y, when the Add to Briefcase dialog is shown to users, the Only include last released revision option is selected by default. Otherwise, the Only include current revision option is selected by default.
PropertyMappings section
<BriefcaseField> = <PropertySetName.PropertyName> [,[<Direction>[<CompareStatus>]][,BRCONLY]]	Pairs of briefcase field names and document property names, one per line. Possible <Direction> parameter values are: WO (Write Only) Write the value in the vault to the briefcase when the document is added or updated. RO (Read Only) Add the field to the briefcase for the document, but leave it empty. On import, the property in the vault is updated from the briefcase. RW (Read Write) Write the value in the vault to the briefcase when the document is added or updated. On import, the property in the vault is updated from the briefcase. In all cases, the field in the briefcase is writable. Possible <CompareStatus> parameter values are: - (Ignore) This mapping is ignored when the briefcase fields are compared to the properties in the vault to determine if the status of the document is Properties changed. + (Evaluate) This mapping is evaluated when the briefcase fields are compared to the properties in the vault to determine if the status of the document is Properties changed. When this parameter is omitted, + is assumed. The BRCONLY parameter only defines the field in the briefcase. The field value is never read from or written to the vault. If present, <CompareStatus> is ignored. If the specified property name exists, it is used to specify the briefcase field type and display name. If the special property set name $$Briefcase is specified, then <PropertyName> specifies the briefcase field type as one of: STRING, BYTE, INT, LONG, SINGLE, DOUBLE, BOOLEAN, DATE, CURRENCY, BLOB, PLAINMEMO, RTFMEMO. Note Mapping a date/time property to a briefcase field will not include the time. Only the date will be copied.

Related concepts

Understanding briefcases